为工程制作文档

为您 Kanzi Studio 工程中的节点和资源添加文档，以描述您的工程项目的。

为工程制作文档

要为工程制作文档：

在主菜单中选择工程 (Project) > 属性 (Properties) 并在描述 (Description) 属性的属性 (Properties) 中写入工程描述。
当您将鼠标悬停在工程名称上，您可以在 Kanzi Studio 快速启动 (Quick Start) 窗口中看到此说明。
在工程 (Project) 或素材库 (Library) 中选择要添加描述的项，在属性 (Properties) 中添加描述 (Description) 属性，并为该项写入描述。
使用描述 (Description) 描述编辑器制定内容的格式。您可以在描述中包括超链接。
选择文件 (File) > 导出 (Export) > 导出描述 (Export Descriptions)。
Kanzi Studio 导出纯文本文件，其中包括具有描述 (Description) 属性的项名称、路径和描述。Kanzi Studio 在存储工程 kzproj 文件的相同目录中导出此文件。当您导出 kzb 文件时，Kanzi Studio 不含描述 (Description) 属性。

建议
Kanzi Studio 默认将描述文件命名为 <project_name>_descriptions.txt。您可以在工程 (Project) > 属性 (Properties) 中使用描述文件名称 (Descriptions File Name) 属性设置文件名称。

Kanzi Studio 导出描述时，会将链接添加到状态栏 (Status Bar) 的文本文件中，您可在素材库 (Library) 窗口下和日志 (Log) 窗口中找到。点击链接将打开包含已导出文件的目录。

另请参阅
创建工程
配置 Kanzi Studio 工程
创建工程的备份
导入工程
合并工程
清理您的工程
查找无效的工程项
将版本控制系统用于 Kanzi

打开导航

为工程制作文档

为工程制作文档

另请参阅